home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XAllocClassHint.z / XAllocClassHint
Encoding:
Text File  |  2002-10-03  |  5.9 KB  |  133 lines

  1.  
  2.  
  3.  
  4.      XXXXAAAAllllllllooooccccCCCCllllaaaassssssssHHHHiiiinnnntttt((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXAAAAllllllllooooccccCCCCllllaaaassssssssHHHHiiiinnnntttt((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XAllocClassHint, XSetClassHint, XGetClassHint, XClassHint -
  10.           allocate class hints structure and set or read a window's
  11.           WM_CLASS property
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           XClassHint *XAllocClassHint()
  15.  
  16.           XSetClassHint(_d_i_s_p_l_a_y, _w, _c_l_a_s_s__h_i_n_t_s)
  17.                 Display *_d_i_s_p_l_a_y;
  18.                 Window _w;
  19.                 XClassHint *_c_l_a_s_s__h_i_n_t_s;
  20.  
  21.           Status XGetClassHint(_d_i_s_p_l_a_y, _w, _c_l_a_s_s__h_i_n_t_s__r_e_t_u_r_n)
  22.                 Display *_d_i_s_p_l_a_y;
  23.                 Window _w;
  24.                 XClassHint *_c_l_a_s_s__h_i_n_t_s__r_e_t_u_r_n;
  25.  
  26.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  27.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  28.  
  29.           _c_l_a_s_s__h_i_n_t_s
  30.                     Specifies the _X_C_l_a_s_s_H_i_n_t structure that is to be
  31.                     used.
  32.  
  33.           _c_l_a_s_s__h_i_n_t_s__r_e_t_u_r_n
  34.                     Returns the _X_C_l_a_s_s_H_i_n_t structure.
  35.  
  36.           _w         Specifies the window.
  37.  
  38.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  39.           The _X_A_l_l_o_c_C_l_a_s_s_H_i_n_t function allocates and returns a pointer
  40.           to a _X_C_l_a_s_s_H_i_n_t structure.  Note that the pointer fields in
  41.           the _X_C_l_a_s_s_H_i_n_t structure are initially set to NULL.  If
  42.           insufficient memory is available, _X_A_l_l_o_c_C_l_a_s_s_H_i_n_t returns
  43.           NULL.  To free the memory allocated to this structure, use
  44.           _X_F_r_e_e.
  45.  
  46.           The _X_S_e_t_C_l_a_s_s_H_i_n_t function sets the class hint for the
  47.           specified window.  If the strings are not in the Host
  48.           Portable Character Encoding, the result is implementation-
  49.           dependent.
  50.  
  51.           _X_S_e_t_C_l_a_s_s_H_i_n_t can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  52.  
  53.           The _X_G_e_t_C_l_a_s_s_H_i_n_t function returns the class hint of the
  54.           specified window to the members of the supplied structure.
  55.           If the data returned by the server is in the Latin Portable
  56.           Character Encoding, then the returned strings are in the
  57.           Host Portable Character Encoding.  Otherwise, the result is
  58.           implementation-dependent.  It returns a nonzero status on
  59.           success; otherwise, it returns a zero status.  To free
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXAAAAllllllllooooccccCCCCllllaaaassssssssHHHHiiiinnnntttt((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXAAAAllllllllooooccccCCCCllllaaaassssssssHHHHiiiinnnntttt((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           res_name and res_class when finished with the strings, use
  75.           _X_F_r_e_e on each individually.
  76.  
  77.           _X_G_e_t_C_l_a_s_s_H_i_n_t can generate a _B_a_d_W_i_n_d_o_w error.
  78.  
  79.      PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS
  80.           WM_CLASS  Set by application programs to allow window and
  81.                     session managers to obtain the application's
  82.                     resources from the resource database.
  83.  
  84.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  85.           The _X_C_l_a_s_s_H_i_n_t structure contains:
  86.  
  87.           typedef struct {
  88.                char *res_name;
  89.                char *res_class;
  90.           } XClassHint;
  91.  
  92.           The res_name member contains the application name, and the
  93.           res_class member contains the application class. Note that
  94.           the name set in this property may differ from the name set
  95.           as WM_NAME.  That is, WM_NAME specifies what should be
  96.           displayed in the title bar and, therefore, can contain
  97.           temporal information (for example, the name of a file
  98.           currently in an editor's buffer).  On the other hand, the
  99.           name specified as part of WM_CLASS is the formal name of the
  100.           application that should be used when retrieving the
  101.           application's resources from the resource database.
  102.  
  103.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  104.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  105.                     resource or server memory.
  106.  
  107.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  108.                     defined Window.
  109.  
  110.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  111.           XAllocIconSize(3X11), XAllocSizeHints(3X11),
  112.           XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11),
  113.           XSetTransientForHint(3X11), XSetTextProperty(3X11),
  114.           XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
  115.           XSetWMIconName(3X11), XSetWMName(3X11),
  116.           XSetWMProperties(3X11), XSetWMProtocols(3X11),
  117.           XStringListToTextProperty(3X11)
  118.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.